/*
Copyright (c) 2009, Young Digital Planet SA
All rights reserved.

* Redistribution and use in source and binary forms, with or without 
  modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this 
  list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, 
  this list of conditions and the following disclaimer in the documentation 
  and/or other materials provided with the distribution.
* Neither the name of the Young Digital Planet SA nor the names of its 
  contributors may be used to endorse or promote products derived from this 
  software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
POSSIBILITY OF SUCH DAMAGE.
*/
package pl.ydp.utils{
	import flash.display.DisplayObject;
	
	/**
	 * Interface for containers with horizontal and vertical scrolls,
	 * that can scroll its DisplayObject content.
	 */
	public interface IScrollableContainer{
		
		/**
		 * Content inside the container which will be scrolled;
		 */
		function get content():DisplayObject;
		function set content(dObj:DisplayObject):void;
		
		/**
		 * Number that represents the maximum horizontal scroll position.
		 */
		function get maxHScrollPosition():Number;
		
		/**
		 * Number that represents the minimum horizontal scroll position.
		 */
 	 	function get minHScrollPosition():Number;
 	 	
 	 	/**
		 * Number that represents the maximum vertical scroll position.
		 */
 	 	function get maxVScrollPosition():Number;
 	 	
 	 	/**
		 * Number that represents the minimum vertical scroll position.
		 */
 	 	function get minVScrollPosition():Number;
 	 	
 	 	/**
 	 	 * Number that represents the current vertical scroll position.
 	 	 */
 	 	function get verticalScrollPosition():Number;
		function set verticalScrollPosition(position:Number):void;
		
		/**
 	 	 * Number that represents the current horizontal scroll position.
 	 	 */
		function get horizontalScrollPosition():Number;
		function set horizontalScrollPosition(position:Number):void
		
		/**
		 * A Boolean value that indicates whether a horizontal scroll is enabled.
		 */
		function get isHScrollEnabled():Boolean;
		
		/**
		 * A Boolean value that indicates whether a vertical scroll is enabled.
		 */
		function get isVScrollEnabled():Boolean; 
	}
}